home *** CD-ROM | disk | FTP | other *** search
/ Aminet 6 / Aminet 6 - June 1995.iso / Aminet / util / conv / base64.lha / base64.doc next >
Encoding:
Text File  |  1995-04-12  |  2.9 KB  |  80 lines
  1.  
  2.      ================================================================
  3.       $VER: base64.doc 1.1 (12.4.95) Copyright © 1995 Ralph Seichter
  4.      ================================================================
  5.  
  6.  
  7. PURPOSE:
  8.  
  9. This program was designed to encode/decode data using the base64 encoding
  10. scheme, which is widely used in MIME messages. Text and especially binary
  11. data is converted into a 7-bit-clean format, to ensure correct transport in
  12. virtually every major computer network. 'base64' will create a MIME message
  13. header if you wish. Requires 'dos.library' V36 (OS 2.x) or better. Returns
  14. RETURN_WARN on error and RETURN_OK otherwise, so it can be easily used in
  15. shell scripts.
  16.  
  17.  
  18. COMMAND TEMPLATE:
  19.  
  20.   FROM         Input stream (defaults to standard input). If specified,
  21.                the file name will be added to "Content-Type:" header, if
  22.                the MIME keyword is also found.
  23.  
  24.   TO           Output stream (defaults to standard output).
  25.  
  26.   D=DECODE/S   Decode data (message headers will be ignored).
  27.  
  28.   E=ENCODE/S   Encode data. You *must* specify either decode or encode!
  29.  
  30.   CRLF/S       Create CR/LF pairs instead of single LF codes at the end
  31.                of each output line (some mailer daemons require this).
  32.  
  33.   MIME/S       Create a MIME message header.
  34.  
  35.   CTYPE/K      Defaults to "Content-Type: application/octet-stream".
  36.  
  37.   DESCR/K      Entry for "Content-Description:" (no default).
  38.  
  39.  
  40. USAGE EXAMPLES:
  41.  
  42.   1> base64 encode foo bar
  43.   Encode file 'foo' and write output to 'bar'.
  44.  
  45.   1> base64 decode from bar to copy_of_foo
  46.   Decode file 'bar' and write output to 'copy_of_foo'.
  47.  
  48.   1> base64 encode c:type mime crlf
  49.   Encode file 'c:type' using the standard output stream.
  50.   Create a MIME message header and use CR/LF pairs.
  51.  
  52.   1> base64 encode odie.gif ctype="image/gif" descr="A picture of Odie"
  53.   Encode the GIF picture and define headers "Content-Type: image/gif"
  54.   and "Content-Description: A picture of Odie".
  55.  
  56.  
  57. HISTORY:
  58.  
  59.   V1.0 (04.04.95) Initial release.
  60.  
  61.   V1.1 (12.04.95) Using the MIME keyword no longer confuses the internal
  62.                   I/O error handling (this happened sometimes in V1.0).
  63.  
  64.  
  65. COPYRIGHT NOTICE AND DISCLAIMER:
  66.  
  67. 'base64' and all other distribution archive contents are Copyright © 1995
  68. Ralph Seichter, all rights reserved. You may freely use all files and give
  69. copies of it to other users, as long as you don't try to make any profit.
  70. You *MUST NOT* add files to or delete files from the distribution archive!
  71.  
  72. THIS MATERIAL IS PROVIDED "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER
  73. EXPRESS OR IMPLIED, STATUTORY OR OTHERWISE, INCLUDING WITHOUT LIMITATION
  74. ANY IMPLIED WARRANTIES OF NONINFRINGEMENT, MERCHANTABILITY AND FITNESS FOR
  75. A PARTICULAR PURPOSE. THE ENTIRE RISK AS TO THE USE, RESULTS, AND
  76. PERFORMANCE OF THIS MATERIAL IS ASSUMED BY YOU AND IF THE PRODUCT SHOULD
  77. PROVE TO BE DEFECTIVE, YOU ASSUME THE ENTIRE COST OF ALL NECESSARY
  78. SERVICING, REPAIR, OR OTHER REMEDIATION.
  79.  
  80.